Generate Red Ryder 10.0 Menu procedure files using the RR Menu Compiler V1.2
Bug reports to MAYERK via GEnie e-mail
Source code available! Send requests to MAYERK
----- MANIFEST
Menu Compiler.PROC
Menu Compiler documentation
Test.Menus.MC
If you are missing any of these files, search the Freesoft RT software library for the keywords "MENU COMPILER", "MAYERK", or "CREATIVE SOLUTIONS".
----- VERSION 1.2 UPDATE REPORT
This version introduces error checking to prevent strings from exceeding limits set by Red Ryder. The RR compiler does not report when a MENUDOES text is longer than 40 characters, the established limit. It can be quit frustrating trying to debug this since you don't know what's wrong when RR says "Procedure not found, Use \path:filename" during execution. In addition, MC 1.2 now checks all lines to see if they are under the 79 character per line limit. See the table below for absolute limits of <STR_EXP>.
Text Character limit
---- ---------------
all lines <= 79
define menu <STR_EXP> <= 67
add to menu <STR_EXP> <= 67
menudoes <STR_EXP> <= 40
Also, numerous bug fixes to the entire error checking/correction facility.
----- INTRODUCTION
I wrote Menu Compiler.PROC to generate menus much more easily than Scott Watson's somewhat tortured command structure. An input file specifying the contents of a menu is read by Menu Compiler and a procedure source file is generated along with its compiled object file. The menu is generated based on the order of the definitions in the input file; no numbering is required. A major advantage of the menu compiler is the ability to change the relative ordering of the menu and its content without drastic code modification. Format and disable characters are supported. Errors are handled in the least drastic way possible. In some cases, MC will catch errors that Red's compiler won't; protecting you from frustrating run-time errors.
----- WRITING AN INPUT FILE
To generate a menu procedure file you must write an input file. The first two lines of the input file are special. The compiler expects to see specific data there. On lines 3 through the end of the file, the compiler expects to see menu definitions in the format described below.
LINE 1: Seperator string
It may be of any character or length, but it can be used in the document only as a seperator. Make sure it is used ONLY as a seperator. More on what it seperates below.
LINE 2: Menu name
The text that will appear in the menu bar
LINE 3 ... : Menu definitions
Menu definitions are like this: <menu-text><seperator-string><menudoes-text>
For example, suppose I want to create a menu to support GEnie's electronic mail system's command mode. Also assume that for a seperator string I will use the section symbol "§" (option-6). The file would begin like this:
§
GEnie Mail
Status§DISPLAY ALL^M
Send§ENTER^M
Read§\Comm Disk:RSPs:Read Mail.PROC
etc.
Notice that the name of the menu "GEnie Mail" is on the second line of the file. Also notice that there are no spaces between the menu-text and the seperator string and the menudoes-text.
----- GENERATING THE MENU PROCEDURE FILE
Once the input file is finished, simply run Menu Compiler.PROC. You will be prompted for the input and output files. Run time is about 70 seconds for a 20 line menu with no errors.
The Menu Compiler will report errors if it can't find the menu-text, the seperator-string, or the menudoes-text. Since you may still be debugging, you have the option of skipping the line with the error, or aborting the whole procedure. It will also report an error if you try to compile more than 20 lines, Red Ryder's limit. Menu Compiler also checks the length of menu-text, menudoes-text and the menu name so that they are within Red Ryder's limits. In case of error, comments are truncated to 79 characters; command line errors stimulate a dialog box where you may reenter the text so that it is within the string length limitations of Red Ryder. In any case, the Menu Compiler will attempt to generate executable code if at all possible.
----- A WARNING TO HARD DISK USERS
I suspect that the command, USERWRITE, does not make efficient use of disk space. I strongly reccommend that hard disk owners save the output file to a floppy, then copy it onto their hard disk.
While testing this procedure, I've notice that 20K or so of disk space has mysteriously vanished. I can reclaim that missing space when I completely copy the floppy disk onto a blank one. I don't know what else to account for it except that my program does of a lot of USEWRITE's to do the job. I can't believe its my word processor or Red's Compile command that's causing the extreme fragmentation. If you listen to the disk drive when running the Menu Compiler, you'll notice that there is a heck of a lot disk action (both reads and writes). So, draw your own conclusions, but probably better to safe than sorry. It is far easier to clean up an 800K floppy than a 60 Meg hard drive.
----- QUESTIONS, BUG REPORTS, ACCOLADES, PROPOSALS OF MARRIAGE, ETC.
